/* Copyright 2018-2023 The TensorFlow Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=======================================================================*/

// This class has been generated, DO NOT EDIT!

package org.tensorflow.op.image;

import java.util.Arrays;
import org.tensorflow.GraphOperation;
import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.RawOp;
import org.tensorflow.op.RawOpInputs;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Endpoint;
import org.tensorflow.op.annotation.OpInputsMetadata;
import org.tensorflow.op.annotation.OpMetadata;
import org.tensorflow.op.annotation.Operator;
import org.tensorflow.proto.DataType;
import org.tensorflow.types.family.TNumber;

/**
 * Convert one or more images from HSV to RGB.
 * Outputs a tensor of the same shape as the {@code images} tensor, containing the RGB
 * value of the pixels. The output is only well defined if the value in {@code images}
 * are in {@code [0,1]}.
 * <p>See {@code rgb_to_hsv} for a description of the HSV encoding.
 *
 * @param <T> data type for {@code output} output
 */
@OpMetadata(
    opType = HsvToRgb.OP_NAME,
    inputsClass = HsvToRgb.Inputs.class
)
@Operator(
    group = "image"
)
public final class HsvToRgb<T extends TNumber> extends RawOp implements Operand<T> {
  /**
   * The name of this op, as known by TensorFlow core engine
   */
  public static final String OP_NAME = "HSVToRGB";

  private Output<T> output;

  public HsvToRgb(Operation operation) {
    super(operation, OP_NAME);
    int outputIdx = 0;
    output = operation.output(outputIdx++);
  }

  /**
   * Factory method to create a class wrapping a new HSVToRGB operation.
   *
   * @param scope current scope
   * @param images 1-D or higher rank. HSV data to convert. Last dimension must be size 3.
   * @param <T> data type for {@code HSVToRGB} output and operands
   * @return a new instance of HsvToRgb
   */
  @Endpoint(
      describeByClass = true
  )
  public static <T extends TNumber> HsvToRgb<T> create(Scope scope, Operand<T> images) {
    OperationBuilder opBuilder = scope.opBuilder(OP_NAME, "HsvToRgb");
    opBuilder.addInput(images.asOutput());
    return new HsvToRgb<>(opBuilder.build());
  }

  /**
   * Gets output.
   * {@code images} converted to RGB.
   * @return output.
   */
  public Output<T> output() {
    return output;
  }

  @Override
  public Output<T> asOutput() {
    return output;
  }

  @OpInputsMetadata(
      outputsClass = HsvToRgb.class
  )
  public static class Inputs<T extends TNumber> extends RawOpInputs<HsvToRgb<T>> {
    /**
     * 1-D or higher rank. HSV data to convert. Last dimension must be size 3.
     */
    public final Operand<T> images;

    /**
     * The T attribute
     */
    public final DataType T;

    public Inputs(GraphOperation op) {
      super(new HsvToRgb<>(op), op, Arrays.asList("T"));
      int inputIndex = 0;
      images = (Operand<T>) op.input(inputIndex++);
      T = op.attributes().getAttrType("T");
    }
  }
}
